home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / macros / texinfo / New-features < prev    next >
Text File  |  1992-09-16  |  10KB  |  313 lines
  1. Texinfo 2
  2. *********
  3.  
  4. The second edition of the Texinfo manual is now released in a package
  5. with the second version of the various Texinfo support files,
  6. including `texinfo.el', `texnfo-upd.el', and `makeinfo.c'.  The new
  7. manual is considerably larger than the previous one.
  8.  
  9. Here is a brief description of the new Texinfo mode commands 
  10. and the newly described @-commands:
  11.  
  12. New Texinfo Mode Commands
  13. =========================
  14.  
  15. Texinfo mode provides commands and features especially designed for
  16. working with Texinfo files.  More than 20 new commands have been
  17. added, including commands for automatically creating and updating both
  18. nodes and menus.  This is a tedious task when done by hand.
  19.  
  20. The keybindings are intended to be somewhat mnemonic.
  21.  
  22. Update everything
  23. -----------------
  24.  
  25. The `texinfo-master-menu' command is the primary command:
  26.  
  27.      C-c C-u m       Create or update a master menu.
  28.                      With an argument, first create or
  29.                      update all nodes and regular menus.
  30.  
  31. Update Pointers
  32. ---------------
  33.  
  34. Create or update `Next', `Previous', and `Up' node pointers.
  35.  
  36.      C-c C-u C-n     Update a node.
  37.      C-c C-u C-e     Update every node in the buffer.
  38.  
  39. Update Menus
  40. ------------
  41.  
  42. Create or update menus.
  43.  
  44.      C-c C-u C-m     Make or update a menu.
  45.  
  46.      C-c C-u C-a     Make or update all the menus
  47.                      in a buffer; with an argument, 
  48.                      first update all the nodes.
  49.  
  50. Insert Title as Description
  51. ---------------------------
  52.  
  53. Insert a node's chapter or section title in the space for the
  54. description in a menu entry line; position point so you can edit the
  55. insert.  (This command works somewhat differently than the other
  56. insertion commands, which insert only a predefined string.)
  57.  
  58.      C-c C-c C-d     Insert title.
  59.  
  60. Format for Info
  61. ---------------
  62.  
  63. Provide keybindings both for the Info formatting commands that are
  64. written in Emacs Lisp and for `makeinfo' which is written in C.
  65.  
  66. Use the Emacs lisp `texinfo-format...' commands:
  67.  
  68.      C-c C-e C-r     Format the region.
  69.      C-c C-e C-b     Format the buffer.
  70.  
  71. Use `makeinfo':
  72.  
  73.      C-c C-m C-r     Format the region.
  74.      C-c C-m C-b     Format the buffer.
  75.      C-c C-m C-l     Recenter the `makeinfo' output buffer.
  76.      C-c C-m C-k     Kill the `makeinfo' formatting job.
  77.  
  78. Typeset and Print
  79. -----------------
  80.  
  81. Typeset and print Texinfo documents from within Emacs.
  82.  
  83.      C-c C-t C-r     Run TeX on the region.
  84.      C-c C-t C-b     Run TeX on the buffer.
  85.      C-c C-t C-i     Run `texindex'.
  86.      C-c C-t C-p     Print the DVI file.
  87.      C-c C-t C-q     Show the print queue.
  88.      C-c C-t C-d     Delete a job from the print queue.
  89.      C-c C-t C-k     Kill the current TeX formatting job.
  90.      C-c C-t C-x     Quit a currently stopped TeX formatting job.
  91.      C-c C-t C-l     Recenter the output buffer.
  92.  
  93. Other Updating Commands
  94. -----------------------
  95.  
  96. The `other updating commands' do not have standard keybindings because
  97. they are less frequently used.
  98.  
  99.      M-x texinfo-insert-node-lines
  100.                      Insert missing node lines using 
  101.                      section titles as node names.
  102.  
  103.      M-x texinfo-multiple-files-update
  104.                      Update a multi-file document.
  105.  
  106.      M-x texinfo-indent-menu-description
  107.                      Indent descriptions in menus.
  108.  
  109.      M-x texinfo-sequential-update-node
  110.                      Insert node pointers in strict sequence.
  111.  
  112. Newly Described Texinfo @-Commands
  113. ==================================
  114.  
  115. The second edition of the Texinfo manual describes more than 50
  116. commands that were not described in the first edition.  A third or so
  117. of these commands existed in Texinfo but were not documented in the
  118. manual; the others are new.  Here is a listing, with brief
  119. descriptions of them:
  120.  
  121.  
  122. Commands for creating your own index and for merging two indices:
  123.  
  124. `@defindex INDEX-NAME'
  125.      Define a new index and its indexing command.  Print entries in a
  126.      roman font.  Also, the `@defcodeindex' command, which prints
  127.      entries in an `@code' font.
  128.  
  129. `@synindex FROM-INDEX INTO-INDEX'
  130.      Merge the index named in the first argument into the index named
  131.      in the second argument.  Sets FROM-INDEX in the same (roman) font
  132.      as INTO-INDEX.  Also, the `@syncodeindex' command, which prints
  133.      the entries from the first index in `@code' font.
  134.  
  135.  
  136. Many commands to help you describe functions, variables, macros,
  137. commands, user options, special forms and other such artifacts in a
  138. uniform format.
  139.  
  140. `@deffn CATEGORY NAME ARGUMENTS...'
  141.      Format a description for functions, interactive commands, and
  142.      similar entities that may take arguments.  Takes as arguments the
  143.      category of entity being described, the name of this particular
  144.      entity, and its arguments, if any.
  145.  
  146. `@defvr, @defop, ...'
  147.      15 other related commands.
  148.  
  149.  
  150. Special symbols to indicate the results of evaluation or an expansion,
  151. printed output, an error message, equivalence of expressions, and the
  152. location of point.
  153.  
  154. `@equiv{}'
  155.      Indicate the exact equivalence of two forms; special glyph: `=='.
  156.  
  157. `@error{}'
  158.      Indicate that the following text is an error message: `error-->'.
  159.  
  160. `@expansion{}'
  161.      Indicate the result of a macro expansion; special glyph: `==>'.
  162.  
  163. `@point{}'
  164.      Indicate the position of point; special glyph: `-!-'.
  165.  
  166. `@print{}'
  167.      Indicate printed output; special glyph: `-|'.
  168.  
  169. `@result{}'
  170.      Indicate the result of an expression; special glyph: `=>'.
  171.  
  172.  
  173. Commands to customize headings:
  174.  
  175. `@headings ON-OFF-SINGLE-DOUBLE'
  176.      Turn headings on or off, or specify single-sided or double-sided
  177.      headings for printing.
  178.  
  179. `@evenfooting [LEFT] @| [CENTER] @| [RIGHT]'
  180.      Specify footings for even-numbered (left-hand) pages.  Not
  181.      relevant to Info.
  182.  
  183. `@evenheading, @everyheading, @oddheading, ...'
  184.      Five other related commands.
  185.  
  186. `@thischapter'
  187.      In a heading or footing, stands for the number and name of the
  188.      current chapter, in the format `Chapter 1: First Chapter'.
  189.  
  190. `@thischaptername, @thisfile, @thistitle, @thispage'
  191.      Related commands.
  192.  
  193.  
  194. Commands for formatting text:
  195.  
  196. `@cartouche'   
  197.      Draw rounded box surrounding text (not in Info).
  198.  
  199. `@enumerate OPTIONAL-ARG'
  200.      Enumerate a list with letters or numbers.
  201.  
  202. `@exdent LINE-OF-TEXT'
  203.      Remove any indentation a line might have.
  204.  
  205. `@flushleft'
  206.      Left justify every line but leave the right end ragged.  Leave
  207.      font as is.
  208.  
  209. `@flushright'
  210.      Right justify every line but leave the left end ragged.  Leave
  211.      font as is.
  212.  
  213. `@format'
  214.      Like `@example' or `@display', but do not narrow the margins or
  215.      select the fixed-width font.
  216.  
  217. `@ftable FORMATTING-COMMAND'
  218. `@vtable FORMATTING-COMMAND'
  219.      Begin a two-column table, using `@item' for each entry.
  220.      `@ftable' automatically enters each of the items in the 
  221.      first column into the index of functions and `@vtable'
  222.      enters them into the index of variables.  The commands
  223.      are the same as `@table', except for indexing.
  224.  
  225. `@lisp'
  226.      Indent text, do not fill, select fixed-width font.
  227.  
  228. `@smallexample'
  229.      Indent text, do not fill, select fixed-width font.  In
  230.      `@smallbook' format, print text in a smaller font than with the
  231.      `@example' environment.  Also, the `@smalllisp' command.
  232.  
  233. Commands for formatting if a flag is set or cleared:
  234.  
  235. `@set FLAG [STRING]'
  236.      Set FLAG, causing the Texinfo formatting commands to format text
  237.      between subsequent pairs of `@ifset FLAG' and `@end ifset'
  238.      commands.  Optionally, set value of FLAG to STRING.
  239.  
  240. `@value{FLAG}'
  241.      Replace with value to which FLAG is set.
  242.  
  243. `@ifset FLAG ... @end ifset'
  244.      If FLAG is set, the Texinfo formatting commands format text
  245.      between `@ifset FLAG' and the following `@end ifset' command.
  246.  
  247. `@clear FLAG'
  248.      Unset FLAG, preventing the Texinfo formatting commands from
  249.      formatting text between subsequent pairs of `@ifset FLAG' and
  250.      `@end ifset' commands.
  251.  
  252. `@ifclear FLAG ... @end ifclear'
  253.      If FLAG is unset, the Texinfo formatting commands format text
  254.      between `@ifclear FLAG' and the following `@end ifclear' command.
  255.  
  256. Produce unnumbered headings that do not appear in a table of contents:
  257.  
  258. `@heading TITLE'
  259.      Print an unnumbered section-like heading in the text, but not in
  260.      the table of contents of a printed manual.
  261.  
  262. `@chapheading, @majorheading'
  263. `@subheading, @subsubheading'
  264.      Related commands.
  265.  
  266.  
  267. Font commands:
  268.  
  269. `@r{TEXT}'
  270.      Print TEXT in roman font.  No effect in Info.
  271.  
  272. `@sc{TEXT}'
  273.      Set TEXT in the printed output in THE SMALL CAPS FONT and set
  274.      text in the Info file in uppercase letters.
  275.  
  276.  
  277. Miscellaneous:
  278.  
  279. `@author AUTHOR'
  280.      Typeset author's name flushleft and underline it.
  281.  
  282. `@finalout'
  283.      Prevent TeX from printing large black warning rectangles beside
  284.      over-wide lines.
  285.  
  286. `@footnotestyle STYLE'
  287.      Specify footnote style, end or separate.
  288.  
  289. `@dmn{DIMENSION}'
  290.      Format a dimension.
  291.  
  292. `@minus{}'
  293.      Generate a minus sign.
  294.  
  295. `@paragraphindent INDENT'
  296.      Specify paragraph indentation, asis or a number.
  297.  
  298. `@ref{NODE-NAME, [ENTRY], [TOPIC], [INFO-FILE], [MANUAL]}'
  299.      Make a reference.  In the printed manual, the reference does not
  300.      start with a `See'.
  301.  
  302. `@title TITLE'
  303.      Alternative format for a title page.  In the printed manual, set
  304.      a title flush to the left-hand side of the page in a larger than
  305.      normal font and underline it with a black rule.  Also,
  306.      `@subtitle' command.
  307.                
  308. `@subtitle SUBTITLE'
  309.      Subtitle in the alternative title page format.
  310.  
  311. `@today{}'
  312.      Insert the current date.
  313.